man/ostree.repo-config: Update min-free-space-* docs
authorUmang Jain <umang@endlessm.com>
Wed, 12 Dec 2018 08:05:26 +0000 (13:35 +0530)
committerAtomic Bot <atomic-devel@projectatomic.io>
Wed, 12 Dec 2018 14:25:16 +0000 (14:25 +0000)
Docs should reflect the changes done in PR:
https://github.com/ostreedev/ostree/pull/1779

Closes: #1786
Approved by: jlebon

man/ostree.repo-config.xml

index acaa3be544e791314b361d790e3284642a8341e3..618b524b695e61aa878acba0d84b93626885ee6d 100644 (file)
@@ -138,7 +138,11 @@ Boston, MA 02111-1307, USA.
           </para>
           <para>
             If <varname>min-free-space-size</varname> is set to a non-zero
-            value, <varname>min-free-space-percent</varname> is ignored.
+            value, <varname>min-free-space-percent</varname> is ignored. Note
+            that, <varname>min-free-space-percent</varname> is not enforced on
+            metadata objects. It is assumed that metadata objects are relatively
+            small in size compared to content objects and thus kept outside the
+            scope of this option.
           </para>
         </listitem>
       </varlistentry>
@@ -156,7 +160,10 @@ Boston, MA 02111-1307, USA.
           <para>
             If this option is set to a non-zero value, and
             <varname>min-free-space-percent</varname> is also set, this option
-            takes priority.
+            takes priority. Note that, <varname>min-free-space-size</varname> is
+            not enforced on metadata objects. It is assumed that metadata objects
+            are relatively small in size compared to content objects and thus kept
+            outside the scope of this option.
           </para>
         </listitem>
       </varlistentry>